Tangoe Mobile REST API

WAYS TO RECEIVE TANGOE UPDATES

Clients may require visibility into Tangoe Activities from within their ITSM. There are several options for a client to get this data. The data can be pulled by the client via the Tangoe REST API, pulled by the client via the Tangoe Mobile reporting interface, or Tangoe can push the data through a custom workflow if the client has API capabilities to receive the data.

Tangoe Activities have four primary states for triggering data returns to a client system.

1. ordered
2. on_back_order
3. completed
4. cancelled

Update Option 1 [Client API Pull]:

Client uses the API to pull the data.

• GET Request https://{subdomain}.thefutureis.mobi/1/activities
• There are many query parameters that can be used to filter the data.
  • GET Activities link (all activities)
  • GET Activities{ID} link (single activity)

Update Option 2 [Client Initiated Report]:

Client generates reports from the portal on a frequency that works for them and is dropped into an SFTP site.

Figure 1:

Update Option 3 [Tangoe pushes data to the client]:

1. Tangoe can send updates back to a client's ITSM system using a webhook from our workflow application see Figure 2. There are four typical states (ordered, on_back_order, completed, cancelled) with attribute details in each payload that Tangoe can send through the webhook. See Figure 3 for an example payload.

Figure 2:

a. For this option, the client would need to expose an API endpoint and authentication credentials.

• URL:
• Username:
• Password:

b. Tangoe's workflow engine is flexible on what can be configured and sent back to the client's ITSM. This can vary with each client so the client would need to supply what attributes they need to see in their system. Below is an example payload that we typically send back on a closed/completed Activity request.

Figure 3:

{
"number": “RITM1234”,
"state": "3",
"work_notes": "Your mobility request has been completed. The details are as follows:
Assigned to:
  Ticket Number:
  Submitted Date / Time:
  Requestor name / email:
  Ticket Type:
  User Name:
  Wireless Carrier:
  Phone Number:
  Device:
  Plan:
  Plan Costs:
  Area Code:
  Preferred Address:
  Shipping Address:
  Order Tracking URL:
  Port / TOL information:
  Existing Phone Number:
  Account Number:
  Name:
  Transfer Notes: "
}

If integrating through the link out option and not the full API build out but want visibility of Activities submitted in Tangoe.

• Tangoe can build a workflow see Figure 4 that can mirror the Activity being created in Tangoe to their system and close the ticket in their system once Tangoe closes the ticket.
• This would require similar information as a. and b. above.

Figure 4: